home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / rabim501.zip / RA-BIM.DOC < prev    next >
Text File  |  1991-03-30  |  15KB  |  346 lines
  1.  
  2.  
  3.   ┌────────────────────────────────────────────────────────────────────────┐
  4.   │                            RA-BiM  v5.00                               │
  5.   │                  BiModem interface for Remote Access                   │
  6.   └────────────────────────────────────────────────────────────────────────┘
  7.                              by Arthur A. Mol
  8.                       The Owl's Nest BBS, Netherlands
  9.                         +31-2155-12571 (2:512/39 )
  10.                         +31-2155-26527 (2:512/124)
  11.  
  12.                              March 8, 1991
  13.                              ─────────────
  14.  
  15.  
  16.    General stuff
  17.    ─────────────
  18.  
  19.    RA-BiM is an interface between Remote Access and BiModem that will
  20.    use all the features of BiModem but also keeps in  mind  the  user
  21.    limits!
  22.  
  23.    This version has all the features of the REGISTERED version.
  24.    I decided to do so, because I'm affraid I don't have time enough
  25.    anymore to provide the support I would like to. Also I started running
  26.    another BBS package and this makes it much more difficult for me to
  27.    carry out new features in the package.
  28.  
  29.    Due to a lot of problems, I decided to remove the external protocol
  30.    support in this version. This will stay that way, until RA has some
  31.    more support for Bi-Directional transfers. It seemed that the problems
  32.    occured because RA will not look for uploads while a download was done
  33.    and vice versa.
  34.  
  35.    Features
  36.    ────────
  37.  
  38.      NoTimeLimit
  39.      -----------
  40.      Don't limit the users' time while he's in BiModem. Some sysops
  41.      asked for this, because BiModem would also abort the session
  42.      when a user is uploading a file. Using this option will give
  43.      the user a free time limit. The download limit will still be
  44.      maintained though.
  45.  
  46.      GiveCredit
  47.      ----------
  48.      Gives some credit when a user has uploaded a file to your system.
  49.  
  50.      Ofcourse also some bugs were fixed. Bugreports are still welcome
  51.      but please try to be as specific as possible. This will help me
  52.      solve a problem you might have. It also would be a nice idea to
  53.      send your RA-BiM config file along with bugreports.
  54.  
  55.      You can edit the users' time and/or download limit while
  56.      he is in the RA-BiM menu. The following keys must be used for
  57.      this:
  58.  
  59.         ALT-D   -  Adjust download limit
  60.         ALT-T   -  Adjust time limit
  61.  
  62.      Note that these new limits will only affect BiModem. Remote
  63.      Access will still handle the default limits when the user
  64.      returns to the BBS.
  65.      Also, RA-BiM uses direct screen writes to display a window
  66.      if ALT-D or ALT-T is used.
  67.  
  68.    - Flag support. RA-BiM  not only looks at the users'
  69.      security level, but also at the flag settings. If a flag for
  70.      a certain file area is set, then that flag must also be set
  71.      in the record of the user to enable him access to this file
  72.      area.
  73.  
  74.    - Errorlevel Support: RA-BiM fully supports the errorlevels generated
  75.      by BiModem versions 1.21 and up.
  76.  
  77.    - RA-BiM  will by  default  look  for CONFIG.RA in the  directory
  78.      pointed to by the 'Node' keyword.  Instead of using the RA path
  79.      as defined with the 'Node' keyword, you can now also use the
  80.      SET RA= environment variable. If the keyword  'UseEnv' is used,
  81.      RA-BiM will search for CONFIG.RA in the path  specified  by the
  82.      RA environment variable.
  83.      (Note: When using this option, RA-BiM still needs the 'Node'
  84.             keyword along with the node information!)
  85.  
  86.    - You can create a ANS/ASC help file which users can display when
  87.      they need help with BiModem and/or RA-BiM.
  88.      A special keyword must be added to the RA-BiM configuration file
  89.      to enable this feature along with the path and filename (without
  90.      extension) of this help file. The filename of the ANS/ASC screen
  91.      is not hard coded so feel free to use any file name that you like.
  92.      A sample ANS/ASC screen is included in the distribution archive
  93.      but probably could do with some adjustments.
  94.  
  95.    - Option to give your users a free time limit while in BiModem.
  96.  
  97.    - RA-BiM  uses  FILES.RA  to  find out what file areas the user has
  98.      access to.  RA-BiM  looks  into  FILES.RA  and  will  compare the
  99.      security levels of each area to the one that the BiModem user has.
  100.      RA-BiM will make a list of all directories to which his security
  101.      level can give him access and will forward this list to BiModem.
  102.      This forces BiModem only to be capable of sending files from the
  103.      areas that the user has access to.. For instance; users with level
  104.      20 will never receive files from an area that has a level 30 access
  105.      level.
  106.  
  107.      Users with security levels lower than needed for some areas will
  108.      not be able to use BiModem to download from these areas.
  109.      BiModem will give the message 'File not found' in the BiModem
  110.      screen when they try to download from those areas.
  111.  
  112.    - Support  for  elimination  of  escape  characters for  PC pursuit
  113.      connections. BiModem versions 1.20  and lower use this  escaping
  114.      but it can decrease performance.   With BiModem v1.21 and higher
  115.      versions  you  can  eliminate this escaping.  Add the 'NoEscape'
  116.      keyword  to the RA-BiM  configuration  to enable this feature in
  117.      RA-BiM.  If you run  a version  of BiModem lower than v1.21 then
  118.      this keyword must not be used.
  119.  
  120.    - Total Characters Per Second (Cps) is now logged into the RA
  121.      log file.
  122.  
  123.    - Users can select what to do from a short menu that is displayed by
  124.      RA-BiM. (Execute BiModem/Enter files to download/Exit to BBS).
  125.  
  126.    - Users have the option to enter filenames to download before running
  127.      BiModem on the BBS.
  128.  
  129.    - Built-in Carrier Detect. If a user drops the carrier, RA-BiM will
  130.      detect this and gives control back to the BBS.
  131.      (This could happen when users are prompted for file descriptions
  132.       or when entering filenames to download)
  133.  
  134.    - ANSI support
  135.  
  136.    - Multi node/multi BiModem support.
  137.  
  138.    - Possibility to use a separate BiModem.COM for each node
  139.      (eg: BIMOD01.COM, BIMOD02.COM)
  140.  
  141.    - Aborted up/downloads are not recorded. This prevents your users
  142.      yelling at you when a session failed and RA-BiM took credit for the
  143.      whole file length in the user record.  Also this gives a better
  144.      calculation of down loaded/up loaded Kb's and will prevent corrupted
  145.      uploads because of failed transfers.
  146.  
  147.    - When a user omits to send a description along with an upload, RA-BiM
  148.      will prompt the user for a description after the transfer.
  149.  
  150.    - User name is displayed under the BiModem screen so you can see
  151.      instantly who's using BiModem.
  152.  
  153.    - Time and download limits are displayed locally.
  154.      Note: If a user has exceeded his download limit, the download limit
  155.      will be 1 Kb to prevent BiModem from thinking that the limit is '0'
  156.      which would mean NO limit at all!
  157.  
  158.    - Users can send descriptions of their uploads with BiModem which
  159.      will be added to FILES.BBS in your upload directory.
  160.  
  161.    - If the description for an upload is missing, RA-BiM will ask the
  162.      user for a description of the uploaded file(s).
  163.  
  164.    - On line updating of up/download and time statistics (users see what
  165.      they up/DOWN LOADED immediately after the BiModem session ends).
  166.    - Unless you choose to have all Uploads go to a Private area for
  167.      checking Prior to release on your BBS
  168.  
  169.    - RA-BiM will execute BiModem with the proper download and time-
  170.      limits, so users can't download or spend more time using BiModem
  171.      than allowed (If a user selects more KB's to download than
  172.      allowed, BiModem will abort the download after his limit has been
  173.      reached. The user can use a verified download the next day to
  174.      resume his file transfer).
  175.  
  176.    - You have the option to create a LOG FILE with user statistics each
  177.      time a BiModem session is initiated on your BBS.
  178.  
  179.    - If RA-BiM can't find one or more files, a file called RA-BiM?.ERR
  180.      will be created with the name of the file that couldn't be found, so
  181.      when you're not at home, you can always see what went wrong.
  182.      The '?' character in the filename is replaced by the node number that
  183.      called RA-BiM.
  184.  
  185.    - Built-in support for private uploads. A user can start the description
  186.      of his upload with "/".  RA-BiM will then add that file as a private
  187.      upload and will store the description  to  PFILES.BBS in the upload
  188.      directory.
  189.  
  190.    - An RA compatible log entry will be added to the RA log file for each
  191.      file transfer done by BiModem. This entry looks like the normal
  192.      transfer entries that RA writes for transfers like Zmodem and
  193.      other protocols.
  194.      Both log file formats (Opus or Frontdoor style) are supported.
  195.  
  196.  
  197.    Installing RA-BiM as a stand alone menu option:
  198.    ──────────────────────────────────────────────
  199.  
  200.    RA-BiM must be installed into Remote Access as a menu type 7.
  201.    Create a menu type 7 in your files menu that will contain the
  202.    following info on the optional data line:
  203.  
  204.    RA-BiM (RA-BIM.CTL path & filename to), NODE NUMBER, /L (optional)
  205.  
  206.    Example:
  207.  
  208.    D:\PROTOCOL\RA-BIM.EXE D:\PROTOCOL\RA-BIM.CTL *N *M /L
  209.  
  210.    (Note: RA-BiM is not hard coded for a config file named RA-BiM.CTL.
  211.           Use any configuration filename that you like. This also
  212.           enables you to use separate .CTL files for certain menu-
  213.           (BiModem) options!)
  214.  
  215.    Make sure to enter the drive name along with the path names.  Strange
  216.    things can occur if you don't!
  217.    A parameter "/L" is optional. If found, a log file called RA-BiM?.LOG
  218.    will be created with some user statistics.
  219.    The '?' character is replaced by the node number that calls RA-BiM.
  220.  
  221.    It's also recommended to enable the memory swap feature by adding *M
  222.    to the command line.
  223.  
  224.    The RA-BiM control file must contain the following information:
  225.  
  226.    - Full path and filename of the BiModem configuration file
  227.    - LOG FILE format (Opus/Frontdoor style) to be used
  228.    - For each node a line must be supplied with the full path name of that
  229.      node's directory and the path to the BiModem.COM file to use for each
  230.      node.
  231.  
  232.    Take your favorite text editor and create a file which will be used
  233.    as the configuration file for RA-BiM.
  234.    Then use the following keywords to enter the information in this
  235.    file:
  236.  
  237.    UserName     The name of your BBS to be displayed on the RA-BiM screen.
  238.                 Example: UserName The_Owl's_Nest_BBS
  239.                 (Please mind the underscores to be used for spaces!!)
  240.  
  241.    BiModemCfg   Full drive and PATH NAME of the BiModem configuration file
  242.  
  243.    LogFormat    The format of your RA system's LOG FILE.
  244.                 Valid options are:
  245.  
  246.                 LogFormat Opus      (Opus LOG FILE format)
  247.                 LogFormat Frontdoor (Frontdoor LOG FILE format)
  248.  
  249.    Node         Keyword used to supply PATH NAME information for each
  250.                 node.
  251.  
  252.    Optional keywords:
  253.    ──────────────────
  254.  
  255.    NoEscape     Use this only if you run a BiModem version higher
  256.                 than v1.20. It will have no effect on BiModem v1.20
  257.                 or previous versions.
  258.                 This option will disable PC PURSUIT escape characters.
  259.  
  260.    UseEnv       When this option is added to the configuration file,
  261.                 RA-BiM will search for CONFIG.RA in the path specified
  262.                 with the SET RA=.. environment variable.
  263.  
  264.    HelpFilePath This option must be followed by a full path & filename
  265.                 (without extension!) of the help files (ANS/ASC) that
  266.                 users can choose to be displayed when they are in
  267.                 need of help.  When not enabled, RA-BiM will display the
  268.                 text 'No HELP FILE available' with this RA-BiM option.
  269.  
  270.    NoTimeLimit  Use this option when you don't want to use the TIME LIMIT
  271.                 in BiModem that is set by RA for this user.
  272.                 The download limit will still be maintained.
  273.  
  274.  
  275.  
  276.    The RA-BiM configuration file could look something like this:
  277.  
  278.  
  279.    UserName My_Own_Greatest_RemoteAccess_BBS
  280.    BiModemCfg C:\PROTOCOLS\BIMODEM.CFG
  281.    HelpFilePath D:\TXTFILES\RABIMHLP
  282.    NoEscape
  283.    LogFormat Opus
  284.    Node 1 D:\RA1 D:\RA1\RA1.LOG D:\PROTOCOLS\BIMOD01.COM
  285.    Node 2 D:\RA2 D:\RA2\RA2.LOG D:\PROTOCOLS\BIMOD02.COM
  286.    Node 3 E:\RA3 D:\RA3\RA3.LOG D:\PROTOCOLS\BIMOD03.COM
  287.         │ │      │              │
  288.         │ │      │              └────> Full path and filename of the
  289.         │ │      │                     BiModem.COM file used for each node.
  290.         │ │      │
  291.         │ │      └─────> Full path and filename for the LOG FILE of this node.
  292.         │ └────────────> Full PATH NAME for this node.
  293.         └──────────────> Node number
  294.  
  295.  
  296.    An example configuration file for RA-BiM is included in the distribution
  297.    archive.
  298.  
  299.  
  300.    Notes:
  301.    ──────
  302.    You *MUST* supply the full PATH NAMES for all keywords in the RA-BiM
  303.    configuration file. So always use 'D:\TEST\TEST.COM' (or whatever)
  304.    instead of only '\TEST\TEST.COM' or worse: only 'TEST.COM'.
  305.    This also must be done when entering PATH NAMES in BiConfig. RA-BiM
  306.    looks for the drive names in order to find/store certain files so
  307.    PATH NAMES *MUST* be proceeded by the DRIVE NAME!
  308.  
  309.    RA-BiM was successfully tested on several machines from 8Mhz XT's with
  310.    640Kb up to 25Mhz 386's with USR Dual Standard modems using Desqview
  311.    2.26/QEMM 5.00. Also Remote Access v0.03  and BiModem v1.21ß behaved
  312.    nicely with RA-BiM..
  313.  
  314.  
  315.    ────────────
  316.     DISCLAIMER
  317.    ────────────
  318.  
  319.    Every program seems to have a disclaimer, so I decided to include one
  320.    too!
  321.    This program is provided "as is" without warranty of any kind. The user
  322.    of this program agrees to hold the author of this material harmless for
  323.    any direct or consequential damages from its use.
  324.  
  325.  
  326.    Credits:
  327.    ────────
  328.  
  329.    Peter Janssens   - EasyBoard Venray (2:512/1)
  330.    John Barton      - Barnabas, The Caring BBS (2:257/168)
  331.    Dave Krause      - Valley of the Sun (1:114/42)
  332.  
  333.  
  334.     Arthur A. Mol
  335.     P.O. Box 227
  336.     3760 AE  Soest
  337.     Netherlands
  338.  
  339.     BBS The Owl's Nest
  340.     +31-2155-12571 (1200/2400/9600/14400bps HST/V32)
  341.     +31-2155-26527 (300/1200/2400bps)
  342.  
  343.     Fido net address: 2:512/39 & 2:512/124
  344.  
  345.  
  346.